Class/Object

com.google.pubsub.v1.pubsub

CreateSnapshotRequest

Related Docs: object CreateSnapshotRequest | package pubsub

Permalink

final case class CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = ...) extends GeneratedMessage with Message[CreateSnapshotRequest] 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 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

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

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

Instance Constructors

  1. new CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = ...)

    Permalink

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

    labels

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def addAllLabels(__vs: Iterable[(String, String)]): CreateSnapshotRequest

    Permalink

  5. def addLabels(__vs: (String, String)*): CreateSnapshotRequest

    Permalink

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clearLabels: CreateSnapshotRequest

    Permalink

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def companion: CreateSnapshotRequest.type

    Permalink
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage

  14. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. val labels: Map[String, String]

    Permalink

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

  17. def mergeFrom(_input__: CodedInputStream): CreateSnapshotRequest

    Permalink
    Definition Classes
    CreateSnapshotRequest → Message

  18. val name: String

    Permalink

    Required.

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

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def serializedSize: Int

    Permalink
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage

  23. val subscription: String

    Permalink

    Required.

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

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  25. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage

  26. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage

  27. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage

  28. def toProtoString: String

    Permalink
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage

  29. def update(ms: (Lens[CreateSnapshotRequest, CreateSnapshotRequest]) ⇒ Mutation[CreateSnapshotRequest]*): CreateSnapshotRequest

    Permalink
    Definition Classes
    Updatable

  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. def withLabels(__v: Map[String, String]): CreateSnapshotRequest

    Permalink

  34. def withName(__v: String): CreateSnapshotRequest

    Permalink

  35. def withSubscription(__v: String): CreateSnapshotRequest

    Permalink

  36. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

  37. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage

  38. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[CreateSnapshotRequest]

Inherited from Message[CreateSnapshotRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped