Class Topic (2.16.6)

Version 2.16.6

• 4.4.0 (latest)
• 4.3.3
• 4.1.1
• 4.0.7
• 3.7.5
• 3.2.1
• 3.1.1
• 3.0.3
• 2.18.3
• 2.17.0
• 2.16.6
• 2.13.0

A Topic object allows you to interact with a Cloud Pub/Sub topic.

Package

@google-cloud/pubsub!

Constructors

(constructor)(pubsub, name, options)

constructor(pubsub: PubSub, name: string, options?: PublishOptions);

Constructs a new instance of the Topic class

Parameters

Name	Description
pubsub	PubSub
name	string
options	PublishOptions

Properties

getSubscriptionsStream

getSubscriptionsStream: () => ObjectStream<Subscription>;

Property Value

Type	Description
() => ObjectStream<Subscription>

iam

iam: IAM;

Property Value

Type	Description
IAM

metadata

metadata?: TopicMetadata;

Property Value

Type	Description
TopicMetadata

name

name: string;

Property Value

Type	Description
string

parent

parent: PubSub;

Property Value

Type	Description
PubSub

publisher

publisher: Publisher;

Property Value

Type	Description
Publisher

pubsub

pubsub: PubSub;

Property Value

Type	Description
PubSub

request

request: typeof PubSub.prototype.request;

Property Value

Type	Description
typeof PubSub#request

Methods

create(gaxOpts)

create(gaxOpts?: CallOptions): Promise<CreateTopicResponse>;

Parameter

Name	Description
gaxOpts	CallOptions

Returns

Type	Description
Promise<CreateTopicResponse>

create(callback)

create(callback: CreateTopicCallback): void;

Parameter

Name	Description
callback	CreateTopicCallback

Returns

Type	Description
void

create(gaxOpts, callback)

create(gaxOpts: CallOptions, callback: CreateTopicCallback): void;

Parameters

Name	Description
gaxOpts	CallOptions
callback	CreateTopicCallback

Returns

Type	Description
void

createSubscription(name, callback)

createSubscription(name: string, callback: CreateSubscriptionCallback): void;

Parameters

Name	Description
name	string
callback	CreateSubscriptionCallback

Returns

Type	Description
void

createSubscription(name, options)

createSubscription(name: string, options?: CreateSubscriptionOptions): Promise<CreateSubscriptionResponse>;

Parameters

Name	Description
name	string
options	CreateSubscriptionOptions

Returns

Type	Description
Promise<CreateSubscriptionResponse>

createSubscription(name, options, callback)

createSubscription(name: string, options: CreateSubscriptionOptions, callback: CreateSubscriptionCallback): void;

Parameters

Name	Description
name	string
options	CreateSubscriptionOptions
callback	CreateSubscriptionCallback

Returns

Type	Description
void

delete(callback)

delete(callback: EmptyCallback): void;

Parameter

Name	Description
callback	EmptyCallback

Returns

Type	Description
void

delete(gaxOpts)

delete(gaxOpts?: CallOptions): Promise<EmptyResponse>;

Parameter

Name	Description
gaxOpts	CallOptions

Returns

Type	Description
Promise<EmptyResponse>

delete(gaxOpts, callback)

delete(gaxOpts: CallOptions, callback: EmptyCallback): void;

Parameters

Name	Description
gaxOpts	CallOptions
callback	EmptyCallback

Returns

Type	Description
void

exists()

exists(): Promise<ExistsResponse>;

Returns

Type	Description
Promise<ExistsResponse>

exists(callback)

exists(callback: ExistsCallback): void;

Parameter

Name	Description
callback	ExistsCallback

Returns

Type	Description
void

flush()

flush(): Promise<void>;

Returns

Type	Description
Promise<void>

flush(callback)

flush(callback: EmptyCallback): void;

Parameter

Name	Description
callback	EmptyCallback

Returns

Type	Description
void

formatName_(projectId, name)

static formatName_(projectId: string, name: string): string;

Format the name of a topic. A Topic's full name is in the format of 'projects/{projectId}/topics/{topicName}'.

{string}

Parameters

Name	Description
projectId	string
name	string

Returns

Type	Description
string

get(callback)

get(callback: GetTopicCallback): void;

Parameter

Name	Description
callback	GetTopicCallback

Returns

Type	Description
void

get(gaxOpts)

get(gaxOpts?: GetTopicOptions): Promise<GetTopicResponse>;

Parameter

Name	Description
gaxOpts	GetTopicOptions

Returns

Type	Description
Promise<GetTopicResponse>

get(gaxOpts, callback)

get(gaxOpts: GetTopicOptions, callback: GetTopicCallback): void;

Parameters

Name	Description
gaxOpts	GetTopicOptions
callback	GetTopicCallback

Returns

Type	Description
void

getMetadata(callback)

getMetadata(callback: GetTopicMetadataCallback): void;

Parameter

Name	Description
callback	GetTopicMetadataCallback

Returns

Type	Description
void

getMetadata(gaxOpts, callback)

getMetadata(gaxOpts: CallOptions, callback: GetTopicMetadataCallback): void;

Parameters

Name	Description
gaxOpts	CallOptions
callback	GetTopicMetadataCallback

Returns

Type	Description
void

getMetadata(gaxOpts)

getMetadata(gaxOpts?: CallOptions): Promise<GetTopicMetadataResponse>;

Parameter

Name	Description
gaxOpts	CallOptions

Returns

Type	Description
Promise<GetTopicMetadataResponse>

getPublishOptionDefaults()

getPublishOptionDefaults(): PublishOptions;

Get the default publisher options. These may be modified and passed back into .

Returns

Type	Description
PublishOptions

getSubscriptions(callback)

getSubscriptions(callback: GetTopicSubscriptionsCallback): void;

Parameter

Name	Description
callback	GetTopicSubscriptionsCallback

Returns

Type	Description
void

getSubscriptions(options, callback)

getSubscriptions(options: PageOptions, callback: GetTopicSubscriptionsCallback): void;

Parameters

Name	Description
options	PageOptions
callback	GetTopicSubscriptionsCallback

Returns

Type	Description
void

getSubscriptions(options)

getSubscriptions(options?: PageOptions): Promise<GetTopicSubscriptionsResponse>;

Parameter

Name	Description
options	PageOptions

Returns

Type	Description
Promise<GetTopicSubscriptionsResponse>

publish(data, attributes)

publish(data: Buffer, attributes?: Attributes): Promise<string>;

Parameters

Name	Description
data	Buffer
attributes	Attributes

Returns

Type	Description
Promise<string>

publish(data, callback)

publish(data: Buffer, callback: PublishCallback): void;

Parameters

Name	Description
data	Buffer
callback	PublishCallback

Returns

Type	Description
void

publish(data, attributes, callback)

publish(data: Buffer, attributes: Attributes, callback: PublishCallback): void;

Parameters

Name	Description
data	Buffer
attributes	Attributes
callback	PublishCallback

Returns

Type	Description
void

publishJSON(json, attributes)

publishJSON(json: object, attributes?: Attributes): Promise<string>;

Parameters

Name	Description
json	object
attributes	Attributes

Returns

Type	Description
Promise<string>

publishJSON(json, callback)

publishJSON(json: object, callback: PublishCallback): void;

Parameters

Name	Description
json	object
callback	PublishCallback

Returns

Type	Description
void

publishJSON(json, attributes, callback)

publishJSON(json: object, attributes: Attributes, callback: PublishCallback): void;

Parameters

Name	Description
json	object
attributes	Attributes
callback	PublishCallback

Returns

Type	Description
void

publishMessage(message)

publishMessage(message: MessageOptions): Promise<[string]>;

Parameter

Name	Description
message	MessageOptions

Returns

Type	Description
Promise<[string]>

publishMessage(message, callback)

publishMessage(message: MessageOptions, callback: PublishCallback): void;

Parameters

Name	Description
message	MessageOptions
callback	PublishCallback

Returns

Type	Description
void

resumePublishing(orderingKey)

resumePublishing(orderingKey: string): void;

In the event that the client fails to publish an ordered message, all subsequent publish calls using the same ordering key will fail. Calling this method will disregard the publish failure, allowing the supplied ordering key to be used again in the future.

Parameter

Name	Description
orderingKey	string The ordering key in question.

Returns

Type	Description
void

setMetadata(options, gaxOpts)

setMetadata(options: TopicMetadata, gaxOpts?: CallOptions): Promise<SetTopicMetadataResponse>;

Parameters

Name	Description
options	TopicMetadata
gaxOpts	CallOptions

Returns

Type	Description
Promise<SetTopicMetadataResponse>

setMetadata(options, callback)

setMetadata(options: TopicMetadata, callback: SetTopicMetadataCallback): void;

Parameters

Name	Description
options	TopicMetadata
callback	SetTopicMetadataCallback

Returns

Type	Description
void

setMetadata(options, gaxOpts, callback)

setMetadata(options: TopicMetadata, gaxOpts: CallOptions, callback: SetTopicMetadataCallback): void;

Parameters

Name	Description
options	TopicMetadata
gaxOpts	CallOptions
callback	SetTopicMetadataCallback

Returns

Type	Description
void

setPublishOptions(options)

setPublishOptions(options: PublishOptions): void;

Set the publisher options.

Parameter

Name	Description
options	PublishOptions The publisher options.

Returns

Type	Description
void

subscription(name, options)

subscription(name: string, options?: SubscriptionOptions): Subscription;

Create a Subscription object. This command by itself will not run any API requests. You will receive a {module:pubsub/subscription} object, which will allow you to interact with a subscription.

Parameters

Name	Description
name	string Name of the subscription.
options	SubscriptionOptions Configuration object. {Subscription}

Returns

Type	Description
Subscription