final case class CreateSnapshotRequest(name: String = "", subscription: String = "", labels: 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 isprojects/{project}/subscriptions/{sub}
.- labels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
- Annotations
- @SerialVersionUID()
- Source
- CreateSnapshotRequest.scala
- Alphabetic
- By Inheritance
- CreateSnapshotRequest
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CreateSnapshotRequest(name: String = "", subscription: String = "", labels: 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 isprojects/{project}/subscriptions/{sub}
.- labels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllLabels(__vs: Iterable[(String, String)]): CreateSnapshotRequest
- def addLabels(__vs: (String, String)*): CreateSnapshotRequest
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearLabels: CreateSnapshotRequest
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: CreateSnapshotRequest.type
- Definition Classes
- CreateSnapshotRequest → GeneratedMessage
- def discardUnknownFields: CreateSnapshotRequest
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- CreateSnapshotRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- CreateSnapshotRequest → GeneratedMessage
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val labels: Map[String, String]
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- CreateSnapshotRequest → GeneratedMessage
- val subscription: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- CreateSnapshotRequest → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[CreateSnapshotRequest, CreateSnapshotRequest]) => Mutation[CreateSnapshotRequest]*): CreateSnapshotRequest
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withLabels(__v: Map[String, String]): CreateSnapshotRequest
- def withName(__v: String): CreateSnapshotRequest
- def withSubscription(__v: String): CreateSnapshotRequest
- def withUnknownFields(__v: UnknownFieldSet): CreateSnapshotRequest
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- CreateSnapshotRequest → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage