final case class CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...) 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 <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. 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
CreateSnapshotrequest; 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
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
- Annotations
- @SerialVersionUID()
- Source
- CreateSnapshotRequest.scala
- Alphabetic
- By Inheritance
- CreateSnapshotRequest
- Product
- Equals
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...)
- 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 <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. 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
CreateSnapshotrequest; 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
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
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( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
companion: CreateSnapshotRequest.type
- Definition Classes
- CreateSnapshotRequest → GeneratedMessage
- def discardUnknownFields: CreateSnapshotRequest
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- 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