The service that an application uses to manipulate topics, and to send messages to a topic. v1
Package
@google-cloud/pubsubConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of PublisherClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new PublisherClient({fallback: true}, gax); ```
Properties
apiEndpoint
get
apiEndpoint
()
:
string
;
The DNS address for this API service.
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
iamClient
iamClient
:
IamClient
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
publisherStub
publisherStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
universeDomain
get
universeDomain
()
:
string
;
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createTopic(request, options)
createTopic
(
request
?:
protos
.
google
.
pubsub
.
v1
.
ITopic
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
ITopic
|
undefined
,
{}
|
undefined
]>;
Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
request
options
Promise
<[ protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.ITopic
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
createTopic(request, options, callback)
createTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
ITopic
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
ITopic
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.ITopic
| null | undefined, {} | null | undefined>
void
createTopic(request, callback)
createTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
ITopic
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
ITopic
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.ITopic
| null | undefined, {} | null | undefined>
void
deleteTopic(request, options)
deleteTopic
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
|
undefined
,
{}
|
undefined
]>;
Deletes the topic with the given name. Returns NOT_FOUND
if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic
field is set to _deleted-topic_
.
request
options
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.pubsub.v1.IDeleteTopicRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
deleteTopic(request, options, callback)
deleteTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.pubsub.v1.IDeleteTopicRequest
| null | undefined, {} | null | undefined>
void
deleteTopic(request, callback)
deleteTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.pubsub.v1.IDeleteTopicRequest
| null | undefined, {} | null | undefined>
void
detachSubscription(request, options)
detachSubscription
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionResponse
,
protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionRequest
|
undefined
,
{}
|
undefined
]>;
Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent Pull
and StreamingPull
requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.
request
options
Promise
<[ protos.google.pubsub.v1.IDetachSubscriptionResponse
, protos.google.pubsub.v1.IDetachSubscriptionRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing DetachSubscriptionResponse . Please see the documentation for more details and examples.
detachSubscription(request, options, callback)
detachSubscription
(
request
:
protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionResponse
,
protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.pubsub.v1.IDetachSubscriptionResponse
, protos.google.pubsub.v1.IDetachSubscriptionRequest
| null | undefined, {} | null | undefined>
void
detachSubscription(request, callback)
detachSubscription
(
request
:
protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionRequest
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionResponse
,
protos
.
google
.
pubsub
.
v1
.
IDetachSubscriptionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.pubsub.v1.IDetachSubscriptionResponse
, protos.google.pubsub.v1.IDetachSubscriptionRequest
| null | undefined, {} | null | undefined>
void
getIamPolicy(request, options, callback)
getIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise
< [
IamProtos
.
google
.
iam
.
v1
.
Policy
]>;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
request
IamProtos.google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.Policy
, google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< google.iam.v1.Policy
, google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<[ google.iam.v1.Policy
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getTopic(request, options)
getTopic
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IGetTopicRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
IGetTopicRequest
|
undefined
,
{}
|
undefined
]>;
Gets the configuration of a topic.
request
options
Promise
<[ protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.IGetTopicRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
getTopic(request, options, callback)
getTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
IGetTopicRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
IGetTopicRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.IGetTopicRequest
| null | undefined, {} | null | undefined>
void
getTopic(request, callback)
getTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
IGetTopicRequest
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
IGetTopicRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.IGetTopicRequest
| null | undefined, {} | null | undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listTopics(request, options)
listTopics
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
pubsub
.
v1
.
ITopic
[],
protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
|
null
,
protos
.
google
.
pubsub
.
v1
.
IListTopicsResponse
]>;
Lists matching topics.
request
options
Promise
<[ protos.google.pubsub.v1.ITopic
[], protos.google.pubsub.v1.IListTopicsRequest
| null, protos.google.pubsub.v1.IListTopicsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTopicsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listTopics(request, options, callback)
listTopics
(
request
:
protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
,
protos
.
google
.
pubsub
.
v1
.
IListTopicsResponse
|
null
|
undefined
,
protos
.
google
.
pubsub
.
v1
.
ITopic
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.pubsub.v1.IListTopicsRequest
, protos.google.pubsub.v1.IListTopicsResponse
| null | undefined, protos.google.pubsub.v1.ITopic
>
void
listTopics(request, callback)
listTopics
(
request
:
protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
,
callback
:
PaginationCallback<protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
,
protos
.
google
.
pubsub
.
v1
.
IListTopicsResponse
|
null
|
undefined
,
protos
.
google
.
pubsub
.
v1
.
ITopic
> )
:
void
;
request
callback
PaginationCallback
< protos.google.pubsub.v1.IListTopicsRequest
, protos.google.pubsub.v1.IListTopicsResponse
| null | undefined, protos.google.pubsub.v1.ITopic
>
void
listTopicsAsync(request, options)
listTopicsAsync
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
pubsub
.
v1
.
ITopic
> ;
Equivalent to listTopics
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.pubsub.v1.ITopic
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
listTopicSnapshots(request, options)
listTopicSnapshots
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
,
options
?:
CallOptions
)
:
Promise
< [
string
[],
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
|
null
,
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsResponse
]>;
Lists the names of the snapshots on this topic. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview ) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
request
options
Promise
<[
string[], protos.google.pubsub.v1.IListTopicSnapshotsRequest
| null, protos.google.pubsub.v1.IListTopicSnapshotsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of string. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTopicSnapshotsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listTopicSnapshots(request, options, callback)
listTopicSnapshots
(
request
:
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
,
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsResponse
|
null
|
undefined
,
string
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.pubsub.v1.IListTopicSnapshotsRequest
, protos.google.pubsub.v1.IListTopicSnapshotsResponse
| null | undefined, string>
void
listTopicSnapshots(request, callback)
listTopicSnapshots
(
request
:
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
,
callback
:
PaginationCallback<protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
,
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsResponse
|
null
|
undefined
,
string
> )
:
void
;
request
callback
PaginationCallback
< protos.google.pubsub.v1.IListTopicSnapshotsRequest
, protos.google.pubsub.v1.IListTopicSnapshotsResponse
| null | undefined, string>
void
listTopicSnapshotsAsync(request, options)
listTopicSnapshotsAsync
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<string>
;
Equivalent to listTopicSnapshots
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
<string>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing string. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
listTopicSnapshotsStream(request, options)
listTopicSnapshotsStream
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicSnapshotsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing string on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTopicSnapshotsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listTopicsStream(request, options)
listTopicsStream
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTopicsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listTopicSubscriptions(request, options)
listTopicSubscriptions
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
string
[],
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
|
null
,
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsResponse
]>;
Lists the names of the attached subscriptions on this topic.
request
options
Promise
<[
string[], protos.google.pubsub.v1.IListTopicSubscriptionsRequest
| null, protos.google.pubsub.v1.IListTopicSubscriptionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of string. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTopicSubscriptionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listTopicSubscriptions(request, options, callback)
listTopicSubscriptions
(
request
:
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
,
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsResponse
|
null
|
undefined
,
string
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.pubsub.v1.IListTopicSubscriptionsRequest
, protos.google.pubsub.v1.IListTopicSubscriptionsResponse
| null | undefined, string>
void
listTopicSubscriptions(request, callback)
listTopicSubscriptions
(
request
:
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
,
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsResponse
|
null
|
undefined
,
string
> )
:
void
;
request
callback
PaginationCallback
< protos.google.pubsub.v1.IListTopicSubscriptionsRequest
, protos.google.pubsub.v1.IListTopicSubscriptionsResponse
| null | undefined, string>
void
listTopicSubscriptionsAsync(request, options)
listTopicSubscriptionsAsync
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<string>
;
Equivalent to listTopicSubscriptions
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
<string>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing string. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
listTopicSubscriptionsStream(request, options)
listTopicSubscriptionsStream
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IListTopicSubscriptionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing string on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTopicSubscriptionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromProjectTopicName(projectTopicName)
matchProjectFromProjectTopicName
(
projectTopicName
:
string
)
:
string
|
number
;
Parse the project from ProjectTopic resource.
projectTopicName
string
A fully-qualified path representing project_topic resource.
string | number
{string} A string representing the project.
matchProjectFromSchemaName(schemaName)
matchProjectFromSchemaName
(
schemaName
:
string
)
:
string
|
number
;
Parse the project from Schema resource.
schemaName
string
A fully-qualified path representing Schema resource.
string | number
{string} A string representing the project.
matchProjectFromSnapshotName(snapshotName)
matchProjectFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the project from Snapshot resource.
snapshotName
string
A fully-qualified path representing Snapshot resource.
string | number
{string} A string representing the project.
matchProjectFromSubscriptionName(subscriptionName)
matchProjectFromSubscriptionName
(
subscriptionName
:
string
)
:
string
|
number
;
Parse the project from Subscription resource.
subscriptionName
string
A fully-qualified path representing Subscription resource.
string | number
{string} A string representing the project.
matchSchemaFromSchemaName(schemaName)
matchSchemaFromSchemaName
(
schemaName
:
string
)
:
string
|
number
;
Parse the schema from Schema resource.
schemaName
string
A fully-qualified path representing Schema resource.
string | number
{string} A string representing the schema.
matchSnapshotFromSnapshotName(snapshotName)
matchSnapshotFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the snapshot from Snapshot resource.
snapshotName
string
A fully-qualified path representing Snapshot resource.
string | number
{string} A string representing the snapshot.
matchSubscriptionFromSubscriptionName(subscriptionName)
matchSubscriptionFromSubscriptionName
(
subscriptionName
:
string
)
:
string
|
number
;
Parse the subscription from Subscription resource.
subscriptionName
string
A fully-qualified path representing Subscription resource.
string | number
{string} A string representing the subscription.
matchTopicFromProjectTopicName(projectTopicName)
matchTopicFromProjectTopicName
(
projectTopicName
:
string
)
:
string
|
number
;
Parse the topic from ProjectTopic resource.
projectTopicName
string
A fully-qualified path representing project_topic resource.
string | number
{string} A string representing the topic.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
projectTopicPath(project, topic)
projectTopicPath
(
project
:
string
,
topic
:
string
)
:
string
;
Return a fully-qualified projectTopic resource name string.
project
string
topic
string
string
{string} Resource name string.
publish(request, options)
publish
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IPublishRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
pubsub
.
v1
.
IPublishResponse
,
protos
.
google
.
pubsub
.
v1
.
IPublishRequest
|
undefined
,
{}
|
undefined
]>;
Adds one or more messages to the topic. Returns NOT_FOUND
if the topic does not exist.
request
options
Promise
<[ protos.google.pubsub.v1.IPublishResponse
, protos.google.pubsub.v1.IPublishRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing PublishResponse . Please see the documentation for more details and examples.
publish(request, options, callback)
publish
(
request
:
protos
.
google
.
pubsub
.
v1
.
IPublishRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
IPublishResponse
,
protos
.
google
.
pubsub
.
v1
.
IPublishRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.pubsub.v1.IPublishResponse
, protos.google.pubsub.v1.IPublishRequest
| null | undefined, {} | null | undefined>
void
publish(request, callback)
publish
(
request
:
protos
.
google
.
pubsub
.
v1
.
IPublishRequest
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
IPublishResponse
,
protos
.
google
.
pubsub
.
v1
.
IPublishRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.pubsub.v1.IPublishResponse
, protos.google.pubsub.v1.IPublishRequest
| null | undefined, {} | null | undefined>
void
schemaPath(project, schema)
schemaPath
(
project
:
string
,
schema
:
string
)
:
string
;
Return a fully-qualified schema resource name string.
project
string
schema
string
string
{string} Resource name string.
setIamPolicy(request, options, callback)
setIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise
< [
IamProtos
.
google
.
iam
.
v1
.
Policy
]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
request
IamProtos.google.iam.v1.SetIamPolicyRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.Policy
, google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< google.iam.v1.Policy
, google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<[ google.iam.v1.Policy
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
snapshotPath(project, snapshot)
snapshotPath
(
project
:
string
,
snapshot
:
string
)
:
string
;
Return a fully-qualified snapshot resource name string.
project
string
snapshot
string
string
{string} Resource name string.
subscriptionPath(project, subscription)
subscriptionPath
(
project
:
string
,
subscription
:
string
)
:
string
;
Return a fully-qualified subscription resource name string.
project
string
subscription
string
string
{string} Resource name string.
testIamPermissions(request, options, callback)
testIamPermissions
(
request
:
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise
< [
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
request
IamProtos.google.iam.v1.TestIamPermissionsRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.TestIamPermissionsResponse
, google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< google.iam.v1.TestIamPermissionsResponse
, google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<[ google.iam.v1.TestIamPermissionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
updateTopic(request, options)
updateTopic
(
request
?:
protos
.
google
.
pubsub
.
v1
.
IUpdateTopicRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
IUpdateTopicRequest
|
undefined
,
{}
|
undefined
]>;
Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.
request
options
Promise
<[ protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.IUpdateTopicRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
updateTopic(request, options, callback)
updateTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
IUpdateTopicRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
IUpdateTopicRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.IUpdateTopicRequest
| null | undefined, {} | null | undefined>
void
updateTopic(request, callback)
updateTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
IUpdateTopicRequest
,
callback
:
Callback<protos
.
google
.
pubsub
.
v1
.
ITopic
,
protos
.
google
.
pubsub
.
v1
.
IUpdateTopicRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.pubsub.v1.ITopic
, protos.google.pubsub.v1.IUpdateTopicRequest
| null | undefined, {} | null | undefined>
void
