Packages

c

com.google.pubsub.v1

CreateSnapshotRequest

final class CreateSnapshotRequest extends GeneratedMessageV3 with CreateSnapshotRequestOrBuilder 

Request for the `CreateSnapshot` method.

Protobuf type google.pubsub.v1.CreateSnapshotRequest

Source
CreateSnapshotRequest.java
Linear Supertypes
CreateSnapshotRequestOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CreateSnapshotRequest
  2. CreateSnapshotRequestOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def containsLabels(key: String): Boolean 

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


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

    map<string, string> labels = 3;

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: Any): Boolean
    Definition Classes
    CreateSnapshotRequest → AbstractMessage → Message → AnyRef → Any
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getDefaultInstanceForType(): CreateSnapshotRequest
    Definition Classes
    CreateSnapshotRequest → MessageOrBuilder → MessageLiteOrBuilder
  13. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  14. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  16. def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  17. def getLabelsCount(): Int 

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


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

    map<string, string> labels = 3;

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  18. def getLabelsMap(): Map[String, String] 

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


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

    map<string, string> labels = 3;

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  19. def getLabelsOrDefault(key: String, defaultValue: String): String 

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


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

    map<string, string> labels = 3;

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  20. def getLabelsOrThrow(key: String): String 

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


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

    map<string, string> labels = 3;

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  21. def getName(): String 

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


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

    string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

    returns

    The name.

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  22. def getNameBytes(): ByteString 

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


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

    string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

    returns

    The bytes for name.

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  23. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  24. def getParserForType(): Parser[CreateSnapshotRequest]
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3 → Message → MessageLite
  25. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  26. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  27. def getSerializedSize(): Int
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
  28. def getSubscription(): String 

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


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

    string subscription = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

    returns

    The subscription.

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  29. def getSubscriptionBytes(): ByteString 

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


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

    string subscription = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

    returns

    The bytes for subscription.

    Definition Classes
    CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
  30. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3 → MessageOrBuilder
  31. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  32. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  33. def hashCode(): Int
    Definition Classes
    CreateSnapshotRequest → AbstractMessage → Message → AnyRef → Any
  34. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3
  35. def internalGetMapField(number: Int): MapField
    Attributes
    protected[v1]
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3
  36. final def isInitialized(): Boolean
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  39. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3
  42. def newBuilderForType(): Builder
    Definition Classes
    CreateSnapshotRequest → Message → MessageLite
  43. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  44. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  48. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. def toBuilder(): Builder
    Definition Classes
    CreateSnapshotRequest → Message → MessageLite
  51. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  52. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  53. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )
  58. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  59. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    CreateSnapshotRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
  60. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from CreateSnapshotRequestOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped