SDK Client Reference
Classes
BatchError
ChannelError
CustomHttpPattern
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Http
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
HttpRule
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ResourceDescriptor
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ResourceReference
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ExtensionRange
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ReservedRange
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Duration
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Empty
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
EnumDescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
EnumReservedRange
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
EnumOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
EnumValueDescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
EnumValueOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ExtensionRangeOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
FieldDescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
FieldMask
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
FieldOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
FileDescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
FileDescriptorSet
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
FileOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
GeneratedCodeInfo
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Annotation
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
MessageOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
MethodDescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
MethodOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
OneofDescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
OneofOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ServiceDescriptorProto
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ServiceOptions
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
SourceCodeInfo
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Location
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Timestamp
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
UninterpretedOption
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
NamePart
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
AcknowledgeRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
CreateSchemaRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
CreateSnapshotRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DeadLetterPolicy
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DeleteSchemaRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DeleteSnapshotRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DeleteSubscriptionRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DeleteTopicRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DetachSubscriptionRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
DetachSubscriptionResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ExpirationPolicy
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
GetSchemaRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
GetSnapshotRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
GetSubscriptionRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
GetTopicRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListSchemasRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListSchemasResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListSnapshotsRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListSnapshotsResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListSubscriptionsRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListSubscriptionsResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListTopicSnapshotsRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListTopicSnapshotsResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListTopicsRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListTopicsResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListTopicSubscriptionsRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ListTopicSubscriptionsResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
MessageStoragePolicy
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ModifyAckDeadlineRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ModifyPushConfigRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Publisher
create
createTopic
createTopic
deleteTopic
deleteTopic
detachSubscription
detachSubscription
getTopic
getTopic
listTopics
listTopics
listTopicSnapshots
listTopicSnapshots
listTopicSubscriptions
listTopicSubscriptions
publish
publish
updateTopic
updateTopic
PublishRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
PublishResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
PubsubMessage
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
PullRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
PullResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
PushConfig
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
OidcToken
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ReceivedMessage
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
RetryPolicy
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Schema
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
SchemaService
create
createSchema
createSchema
deleteSchema
deleteSchema
getSchema
getSchema
listSchemas
listSchemas
validateMessage
validateMessage
validateSchema
validateSchema
SchemaSettings
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
SeekRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
SeekResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
google.pubsub.v1.Snapshot
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
StreamingPullRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
StreamingPullResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
Subscriber
create
acknowledge
acknowledge
createSnapshot
createSnapshot
createSubscription
createSubscription
deleteSnapshot
deleteSnapshot
deleteSubscription
deleteSubscription
getSnapshot
getSnapshot
getSubscription
getSubscription
listSnapshots
listSnapshots
listSubscriptions
listSubscriptions
modifyAckDeadline
modifyAckDeadline
modifyPushConfig
modifyPushConfig
pull
pull
seek
seek
streamingPull
streamingPull
updateSnapshot
updateSnapshot
updateSubscription
updateSubscription
google.pubsub.v1.Subscription
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
google.pubsub.v1.Topic
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
UpdateSnapshotRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
UpdateSubscriptionRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
UpdateTopicRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ValidateMessageRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ValidateMessageResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ValidateSchemaRequest
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
ValidateSchemaResponse
create
decode
decodeDelimited
encode
encodeDelimited
fromObject
toObject
verify
toJSON
IAM
getPolicy
setPolicy
testPermissions
Message
ack
nack
OpenTelemetryTracer
createSpan
PublishError
PubSub
createSubscription
createTopic
detachSubscription
getSnapshots
getSnapshotsStream
getSubscriptions
getSubscriptionsStream
getSubscriptionsStream
getTopics
getTopicsStream
snapshot
subscription
topic
Snapshot
create
delete
seek
StatusError
Subscription
close
create
createSnapshot
delete
detached
exists
get
getMetadata
modifyPushConfig
open
seek
setMetadata
setOptions
snapshot
Topic
create
createSubscription
delete
exists
flush
get
getMetadata
getSubscriptions
publish
publishJSON
publishMessage
resumePublishing
setMetadata
setPublishOptions
subscription
PublisherClient
close
createTopic
deleteTopic
detachSubscription
getIamPolicy
getProjectId
getTopic
initialize
listTopics
listTopicsAsync
listTopicSnapshots
listTopicSnapshotsAsync
listTopicSnapshotsStream
listTopicsStream
listTopicSubscriptions
listTopicSubscriptionsAsync
listTopicSubscriptionsStream
matchProjectFromProjectName
matchProjectFromProjectTopicName
matchProjectFromSchemaName
matchProjectFromSnapshotName
matchProjectFromSubscriptionName
matchSchemaFromSchemaName
matchSnapshotFromSnapshotName
matchSubscriptionFromSubscriptionName
matchTopicFromProjectTopicName
projectPath
projectTopicPath
publish
schemaPath
setIamPolicy
snapshotPath
subscriptionPath
testIamPermissions
updateTopic
SchemaServiceClient
close
createSchema
deleteSchema
getIamPolicy
getProjectId
getSchema
initialize
listSchemas
listSchemasAsync
listSchemasStream
matchProjectFromProjectName
matchProjectFromProjectTopicName
matchProjectFromSchemaName
matchProjectFromSnapshotName
matchProjectFromSubscriptionName
matchSchemaFromSchemaName
matchSnapshotFromSnapshotName
matchSubscriptionFromSubscriptionName
matchTopicFromProjectTopicName
projectPath
projectTopicPath
schemaPath
setIamPolicy
snapshotPath
subscriptionPath
testIamPermissions
validateMessage
validateSchema
SubscriberClient
acknowledge
close
createSnapshot
createSubscription
deleteSnapshot
deleteSubscription
getIamPolicy
getProjectId
getSnapshot
getSubscription
initialize
listSnapshots
listSnapshotsAsync
listSnapshotsStream
listSubscriptions
listSubscriptionsAsync
listSubscriptionsStream
matchProjectFromProjectName
matchProjectFromProjectTopicName
matchProjectFromSchemaName
matchProjectFromSnapshotName
matchProjectFromSubscriptionName
matchSchemaFromSchemaName
matchSnapshotFromSnapshotName
matchSubscriptionFromSubscriptionName
matchTopicFromProjectTopicName
modifyAckDeadline
modifyPushConfig
projectPath
projectTopicPath
pull
schemaPath
seek
setIamPolicy
snapshotPath
streamingPull
subscriptionPath
testIamPermissions
updateSnapshot
updateSubscription
Modules
@google-cloud/pubsub
Global
gapicConfig
ChannelError
ChannelError
Error thrown when we fail to open a channel for the message stream.
Constructor
new ChannelError
(err)
Parameters:
Name
Type
Description
err
Error
The original error.