final class CreateSnapshotRequest extends GeneratedMessageV3 with CreateSnapshotRequestOrBuilder
Request for the `CreateSnapshot` method.
Protobuf type google.pubsub.v1.CreateSnapshotRequest
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- CreateSnapshotRequest
- CreateSnapshotRequestOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def containsLabels(key: String): Boolean
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];- Definition Classes
- CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
- Annotations
- @Override()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: AnyRef): Boolean
- Definition Classes
- CreateSnapshotRequest → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDefaultInstanceForType(): CreateSnapshotRequest
- Definition Classes
- CreateSnapshotRequest → MessageOrBuilder → MessageLiteOrBuilder
- Annotations
- @Override()
- def getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getField(arg0: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getLabelsCount(): Int
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];- Definition Classes
- CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
- def getLabelsMap(): Map[String, String]
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];- Definition Classes
- CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
- Annotations
- @Override()
- def getLabelsOrDefault(key: String, defaultValue: String): String
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];- Definition Classes
- CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
- Annotations
- @Override()
- def getLabelsOrThrow(key: String): String
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];- Definition Classes
- CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
- Annotations
- @Override()
- 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 [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). 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 [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). 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
- Annotations
- @Override()
- 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 [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). 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 [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). 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
- Annotations
- @Override()
- def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def getParserForType(): Parser[CreateSnapshotRequest]
- Definition Classes
- CreateSnapshotRequest → GeneratedMessageV3 → Message → MessageLite
- Annotations
- @Override()
- def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getRepeatedFieldCount(arg0: FieldDescriptor): Int
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getSerializedSize(): Int
- Definition Classes
- CreateSnapshotRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- 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
- Annotations
- @Override()
- 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
- Annotations
- @Override()
- def getUnknownFields(): UnknownFieldSet
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def hasField(arg0: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def hasOneof(arg0: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def hashCode(): Int
- Definition Classes
- CreateSnapshotRequest → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def internalGetFieldAccessorTable(): FieldAccessorTable
- Attributes
- protected[v1]
- Definition Classes
- CreateSnapshotRequest → GeneratedMessageV3
- Annotations
- @Override()
- def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- def internalGetMapFieldReflection(number: Int): MapFieldReflectionAccessor
- Attributes
- protected[v1]
- Annotations
- @SuppressWarnings() @Override()
- final def isInitialized(): Boolean
- Definition Classes
- CreateSnapshotRequest → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
- Annotations
- @Override()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeExtensionsImmutable(): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[v1]
- Definition Classes
- CreateSnapshotRequest → GeneratedMessageV3
- Annotations
- @Override()
- def newBuilderForType(): Builder
- Definition Classes
- CreateSnapshotRequest → Message → MessageLite
- Annotations
- @Override()
- def newBuilderForType(arg0: BuilderParent): Builder
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3 → AbstractMessage
- def newInstance(unused: UnusedPrivateParameter): AnyRef
- Attributes
- protected[v1]
- Definition Classes
- CreateSnapshotRequest → GeneratedMessageV3
- Annotations
- @Override() @SuppressWarnings()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBuilder(): Builder
- Definition Classes
- CreateSnapshotRequest → Message → MessageLite
- Annotations
- @Override()
- def toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
- def toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
- final def toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def writeDelimitedTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
- def writeReplace(): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.ObjectStreamException])
- def writeTo(output: CodedOutputStream): Unit
- Definition Classes
- CreateSnapshotRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- def writeTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
Deprecated Value Members
- def getLabels(): Map[String, String]
Use
#getLabelsMap()instead.Use
#getLabelsMap()instead.- Definition Classes
- CreateSnapshotRequest → CreateSnapshotRequestOrBuilder
- Annotations
- @Override() @Deprecated
- Deprecated
- def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
- Deprecated