proto-google-cloud-pubsub-v1-scalapb_0.11/com.google.pubsub.v1.pubsub/CreateSnapshotRequest

CreateSnapshotRequest

@SerialVersionUID(0L) final case
class CreateSnapshotRequest(name: String, subscription: String, labels: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CreateSnapshotRequest]

Request for the CreateSnapshot method.

Value Params
labels

See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.

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 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}.

Companion
object
trait Updatable[CreateSnapshotRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def addAllLabels(`__vs`: Iterable[(String, String)]): CreateSnapshotRequest
def addLabels(`__vs`: (String, String)*): CreateSnapshotRequest
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override
def serializedSize: Int
Definition Classes
GeneratedMessage
def toProtoString: String
def withLabels(`__v`: Map[String, String]): CreateSnapshotRequest
def withName(`__v`: String): CreateSnapshotRequest
def withUnknownFields(`__v`: UnknownFieldSet): CreateSnapshotRequest
def writeTo(`_output__`: CodedOutputStream): Unit

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
final
def toByteArray: Array[Byte]

Serializes the messgae and returns a byte array containing its raw bytes

Serializes the messgae and returns a byte array containing its raw bytes

Inherited from
GeneratedMessage
final
def toByteString: ByteString

Serializes the messgae and returns a ByteString containing its raw bytes

Serializes the messgae and returns a ByteString containing its raw bytes

Inherited from
GeneratedMessage
final
def toPMessage: PMessage
Inherited from
GeneratedMessage
final
def writeDelimitedTo(output: OutputStream): Unit
Inherited from
GeneratedMessage
final
def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from
GeneratedMessage