The service that an application uses to manipulate topics, and to send messages to a topic. v1
Package
@google-cloud/pubsub!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of PublisherClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
iamClient
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
publisherStub
publisherStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
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.
Returns | Type |
Description |
| 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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.ITopic
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.ITopic
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.pubsub.v1.ITopic
, protos. google.pubsub.v1.ITopic
| null | undefined, {} | null | undefined>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.ITopic
|
| callback |
Callback
<protos. google.pubsub.v1.ITopic
, protos. google.pubsub.v1.ITopic
| null | undefined, {} | null | undefined>
|
Returns
deleteTopic(request, options)
deleteTopic
(
request
:
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
pubsub
.
v1
.
IDeleteTopicRequest
|
undefined
,
{}
|
undefined
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IDeleteTopicRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IDeleteTopicRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.pubsub.v1.IDeleteTopicRequest
| null | undefined, {} | null | undefined>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IDeleteTopicRequest
|
| callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.pubsub.v1.IDeleteTopicRequest
| null | undefined, {} | null | undefined>
|
Returns
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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IDetachSubscriptionRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IDetachSubscriptionRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.pubsub.v1.IDetachSubscriptionResponse
, protos. google.pubsub.v1.IDetachSubscriptionRequest
| null | undefined, {} | null | undefined>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IDetachSubscriptionRequest
|
| callback |
Callback
<protos. google.pubsub.v1.IDetachSubscriptionResponse
, protos. google.pubsub.v1.IDetachSubscriptionRequest
| null | undefined, {} | null | undefined>
|
Returns
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.
Parameters | Name |
Description |
| request |
IamProtos. google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
|
| options |
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. 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] https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html
for the details.
|
| callback |
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. 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 [Policy].
|
Returns | Type |
Description |
| Promise
<IamProtos. google.iam.v1.Policy
> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. The promise has a method named "cancel" which cancels the ongoing API call.
|
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter | Name |
Description |
| callback |
Callback
<string, undefined, undefined>
|
Returns
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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IGetTopicRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IGetTopicRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.pubsub.v1.ITopic
, protos. google.pubsub.v1.IGetTopicRequest
| null | undefined, {} | null | undefined>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IGetTopicRequest
|
| callback |
Callback
<protos. google.pubsub.v1.ITopic
, protos. google.pubsub.v1.IGetTopicRequest
| null | undefined, {} | null | undefined>
|
Returns
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.
Returns | Type |
Description |
| 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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicsRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| 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
>
|
Returns
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
;
Parameters | Name |
Description |
| 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
>
|
Returns
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.
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<protos. google.pubsub.v1.ITopic
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Topic]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSnapshotsRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSnapshotsRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback
<protos. google.pubsub.v1.IListTopicSnapshotsRequest
, protos. google.pubsub.v1.IListTopicSnapshotsResponse
| null | undefined, string>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSnapshotsRequest
|
| callback |
PaginationCallback
<protos. google.pubsub.v1.IListTopicSnapshotsRequest
, protos. google.pubsub.v1.IListTopicSnapshotsResponse
| null | undefined, string>
|
Returns
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.
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSnapshotsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<string> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSnapshotsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| Transform
|
{Stream} An object stream which emits an object representing [Topic] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSubscriptionsRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSubscriptionsRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback
<protos. google.pubsub.v1.IListTopicSubscriptionsRequest
, protos. google.pubsub.v1.IListTopicSubscriptionsResponse
| null | undefined, string>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSubscriptionsRequest
|
| callback |
PaginationCallback
<protos. google.pubsub.v1.IListTopicSubscriptionsRequest
, protos. google.pubsub.v1.IListTopicSubscriptionsResponse
| null | undefined, string>
|
Returns
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.
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSubscriptionsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| AsyncIterable
<string> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IListTopicSubscriptionsRequest
The request object that will be sent.
|
| options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns | Type |
Description |
| 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
Parameter | Name |
Description |
| projectName |
string
A fully-qualified path representing Project resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromProjectTopicName(projectTopicName)
matchProjectFromProjectTopicName
(
projectTopicName
:
string
)
:
string
|
number
;
Parse the project from ProjectTopic resource.
Parameter | Name |
Description |
| projectTopicName |
string
A fully-qualified path representing project_topic resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromSchemaName(schemaName)
matchProjectFromSchemaName
(
schemaName
:
string
)
:
string
|
number
;
Parse the project from Schema resource.
Parameter | Name |
Description |
| schemaName |
string
A fully-qualified path representing Schema resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromSnapshotName(snapshotName)
matchProjectFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the project from Snapshot resource.
Parameter | Name |
Description |
| snapshotName |
string
A fully-qualified path representing Snapshot resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchProjectFromSubscriptionName(subscriptionName)
matchProjectFromSubscriptionName
(
subscriptionName
:
string
)
:
string
|
number
;
Parse the project from Subscription resource.
Parameter | Name |
Description |
| subscriptionName |
string
A fully-qualified path representing Subscription resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the project.
|
matchSchemaFromSchemaName(schemaName)
matchSchemaFromSchemaName
(
schemaName
:
string
)
:
string
|
number
;
Parse the schema from Schema resource.
Parameter | Name |
Description |
| schemaName |
string
A fully-qualified path representing Schema resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the schema.
|
matchSnapshotFromSnapshotName(snapshotName)
matchSnapshotFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the snapshot from Snapshot resource.
Parameter | Name |
Description |
| snapshotName |
string
A fully-qualified path representing Snapshot resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the snapshot.
|
matchSubscriptionFromSubscriptionName(subscriptionName)
matchSubscriptionFromSubscriptionName
(
subscriptionName
:
string
)
:
string
|
number
;
Parse the subscription from Subscription resource.
Parameter | Name |
Description |
| subscriptionName |
string
A fully-qualified path representing Subscription resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the subscription.
|
matchTopicFromProjectTopicName(projectTopicName)
matchTopicFromProjectTopicName
(
projectTopicName
:
string
)
:
string
|
number
;
Parse the topic from ProjectTopic resource.
Parameter | Name |
Description |
| projectTopicName |
string
A fully-qualified path representing project_topic resource.
|
Returns | Type |
Description |
| string | number
|
{string} A string representing the topic.
|
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
Parameter
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
projectTopicPath(project, topic)
projectTopicPath
(
project
:
string
,
topic
:
string
)
:
string
;
Return a fully-qualified projectTopic resource name string.
Parameters
Returns | Type |
Description |
| 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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IPublishRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IPublishRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.pubsub.v1.IPublishResponse
, protos. google.pubsub.v1.IPublishRequest
| null | undefined, {} | null | undefined>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IPublishRequest
|
| callback |
Callback
<protos. google.pubsub.v1.IPublishResponse
, protos. google.pubsub.v1.IPublishRequest
| null | undefined, {} | null | undefined>
|
Returns
schemaPath(project, schema)
schemaPath
(
project
:
string
,
schema
:
string
)
:
string
;
Return a fully-qualified schema resource name string.
Parameters
Returns | Type |
Description |
| 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.
Parameters | Name |
Description |
| request |
IamProtos. google.iam.v1.SetIamPolicyRequest
The request object that will be sent.
|
| options |
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. 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] https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html
for the details.
|
| callback |
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. 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 [TestIamPermissionsResponse].
|
Returns | Type |
Description |
| Promise
<IamProtos. google.iam.v1.Policy
> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. 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.
Parameters
Returns | Type |
Description |
| string
|
{string} Resource name string.
|
subscriptionPath(project, subscription)
subscriptionPath
(
project
:
string
,
subscription
:
string
)
:
string
;
Return a fully-qualified subscription resource name string.
Parameters
Returns | Type |
Description |
| 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.
Parameters | Name |
Description |
| request |
IamProtos. google.iam.v1.TestIamPermissionsRequest
The request object that will be sent.
|
| options |
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. 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] https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html
for the details.
|
| callback |
Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. 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 [TestIamPermissionsResponse].
|
Returns | Type |
Description |
| Promise
<IamProtos. google.iam.v1.TestIamPermissionsResponse
> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. 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
]>;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IUpdateTopicRequest
|
| options |
CallOptions
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IUpdateTopicRequest
|
| options |
CallOptions
|
| callback |
Callback
<protos. google.pubsub.v1.ITopic
, protos. google.pubsub.v1.IUpdateTopicRequest
| null | undefined, {} | null | undefined>
|
Returns
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
;
Parameters | Name |
Description |
| request |
protos. google.pubsub.v1.IUpdateTopicRequest
|
| callback |
Callback
<protos. google.pubsub.v1.ITopic
, protos. google.pubsub.v1.IUpdateTopicRequest
| null | undefined, {} | null | undefined>
|
Returns