http4s-grpc-google-cloud-pubsub-v1
1.105.9+0.0.4
API
Generated with
http4s-grpc-google-cloud-pubsub-v1/com.google.pubsub.v1.pubsub/CreateSnapshotRequest

CreateSnapshotRequest

com.google.pubsub.v1.pubsub.CreateSnapshotRequest
See theCreateSnapshotRequest companion object
final case class CreateSnapshotRequest(name: String, subscription: String, labels: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CreateSnapshotRequest]

Request for the CreateSnapshot method.

Attributes

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
Source:
CreateSnapshotRequest.scala
Graph
Supertypes
trait Updatable[CreateSnapshotRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
CreateSnapshotRequest.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
CreateSnapshotRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): CreateSnapshotRequest
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
CreateSnapshotRequest.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

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

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

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[CreateSnapshotRequest, CreateSnapshotRequest] => () => CreateSnapshotRequest*): A

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
Generated with