src/apis/pubsublite/v1.ts
Pub/Sub Lite API
const {google} = require('googleapis');
const pubsublite = google.pubsublite('v1');
Properties |
constructor(options: GlobalOptions, google?: GoogleConfigurable)
|
|||||||||
|
Defined in src/apis/pubsublite/v1.ts:118
|
|||||||||
|
Parameters :
|
| admin |
Type : Resource$Admin
|
|
Defined in src/apis/pubsublite/v1.ts:116
|
| context |
Type : APIRequestContext
|
|
Defined in src/apis/pubsublite/v1.ts:115
|
| cursor |
Type : Resource$Cursor
|
|
Defined in src/apis/pubsublite/v1.ts:117
|
| topicStats |
Type : Resource$Topicstats
|
|
Defined in src/apis/pubsublite/v1.ts:118
|
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosPromise,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace pubsublite_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Pub/Sub Lite API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
* ```
*/
export class Pubsublite {
context: APIRequestContext;
admin: Resource$Admin;
cursor: Resource$Cursor;
topicStats: Resource$Topicstats;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.admin = new Resource$Admin(this.context);
this.cursor = new Resource$Cursor(this.context);
this.topicStats = new Resource$Topicstats(this.context);
}
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {}
/**
* The throughput capacity configuration for each partition.
*/
export interface Schema$Capacity {
/**
* Publish throughput capacity per partition in MiB/s. Must be \>= 4 and <= 16.
*/
publishMibPerSec?: number | null;
/**
* Subscribe throughput capacity per partition in MiB/s. Must be \>= 4 and <= 32.
*/
subscribeMibPerSec?: number | null;
}
/**
* Request for CommitCursor.
*/
export interface Schema$CommitCursorRequest {
/**
* The new value for the committed cursor.
*/
cursor?: Schema$Cursor;
/**
* The partition for which to update the cursor. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions).
*/
partition?: string | null;
}
/**
* Response for CommitCursor.
*/
export interface Schema$CommitCursorResponse {}
/**
* Compute the current head cursor for a partition.
*/
export interface Schema$ComputeHeadCursorRequest {
/**
* Required. The partition for which we should compute the head cursor.
*/
partition?: string | null;
}
/**
* Response containing the head cursor for the requested topic and partition.
*/
export interface Schema$ComputeHeadCursorResponse {
/**
* The head cursor.
*/
headCursor?: Schema$Cursor;
}
/**
* Compute statistics about a range of messages in a given topic and partition.
*/
export interface Schema$ComputeMessageStatsRequest {
/**
* The exclusive end of the range. The range is empty if end_cursor <= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will retrieve all messages.
*/
endCursor?: Schema$Cursor;
/**
* Required. The partition for which we should compute message stats.
*/
partition?: string | null;
/**
* The inclusive start of the range.
*/
startCursor?: Schema$Cursor;
}
/**
* Response containing stats for messages in the requested topic and partition.
*/
export interface Schema$ComputeMessageStatsResponse {
/**
* The number of quota bytes accounted to these messages.
*/
messageBytes?: string | null;
/**
* The count of messages.
*/
messageCount?: string | null;
/**
* The minimum event timestamp across these messages. For the purposes of this computation, if a message does not have an event time, we use the publish time. The timestamp will be unset if there are no messages.
*/
minimumEventTime?: string | null;
/**
* The minimum publish timestamp across these messages. Note that publish timestamps within a partition are not guaranteed to be non-decreasing. The timestamp will be unset if there are no messages.
*/
minimumPublishTime?: string | null;
}
/**
* Compute the corresponding cursor for a publish or event time in a topic partition.
*/
export interface Schema$ComputeTimeCursorRequest {
/**
* Required. The partition for which we should compute the cursor.
*/
partition?: string | null;
/**
* Required. The target publish or event time. Specifying a future time will return an unset cursor.
*/
target?: Schema$TimeTarget;
}
/**
* Response containing the cursor corresponding to a publish or event time in a topic partition.
*/
export interface Schema$ComputeTimeCursorResponse {
/**
* If present, the cursor references the first message with time greater than or equal to the specified target time. If such a message cannot be found, the cursor will be unset (i.e. `cursor` is not present).
*/
cursor?: Schema$Cursor;
}
/**
* A cursor that describes the position of a message within a topic partition.
*/
export interface Schema$Cursor {
/**
* The offset of a message within a topic partition. Must be greater than or equal 0.
*/
offset?: string | null;
}
/**
* The settings for a subscription's message delivery.
*/
export interface Schema$DeliveryConfig {
/**
* The DeliveryRequirement for this subscription.
*/
deliveryRequirement?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response for ListPartitionCursors
*/
export interface Schema$ListPartitionCursorsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The partition cursors from this request.
*/
partitionCursors?: Schema$PartitionCursor[];
}
/**
* Response for ListSubscriptions.
*/
export interface Schema$ListSubscriptionsResponse {
/**
* A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
*/
nextPageToken?: string | null;
/**
* The list of subscriptions in the requested parent. The order of the subscriptions is unspecified.
*/
subscriptions?: Schema$Subscription[];
}
/**
* Response for ListTopics.
*/
export interface Schema$ListTopicsResponse {
/**
* A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
*/
nextPageToken?: string | null;
/**
* The list of topic in the requested parent. The order of the topics is unspecified.
*/
topics?: Schema$Topic[];
}
/**
* Response for ListTopicSubscriptions.
*/
export interface Schema$ListTopicSubscriptionsResponse {
/**
* A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
*/
nextPageToken?: string | null;
/**
* The names of subscriptions attached to the topic. The order of the subscriptions is unspecified.
*/
subscriptions?: string[] | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {[key: string]: any} | null;
}
/**
* Metadata for long running operations.
*/
export interface Schema$OperationMetadata {
/**
* The time the operation was created.
*/
createTime?: string | null;
/**
* The time the operation finished running. Not set if the operation has not completed.
*/
endTime?: string | null;
/**
* Resource path for the target of the operation. For example, targets of seeks are subscription resources, structured like: projects/{project_number\}/locations/{location\}/subscriptions/{subscription_id\}
*/
target?: string | null;
/**
* Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* The settings for a topic's partitions.
*/
export interface Schema$PartitionConfig {
/**
* The capacity configuration.
*/
capacity?: Schema$Capacity;
/**
* The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
*/
count?: string | null;
/**
* DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
*/
scale?: number | null;
}
/**
* A pair of a Cursor and the partition it is for.
*/
export interface Schema$PartitionCursor {
/**
* The value of the cursor.
*/
cursor?: Schema$Cursor;
/**
* The partition this is for.
*/
partition?: string | null;
}
/**
* The settings for a topic's message retention.
*/
export interface Schema$RetentionConfig {
/**
* How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.
*/
period?: string | null;
/**
* The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
*/
perPartitionBytes?: string | null;
}
/**
* Request for SeekSubscription.
*/
export interface Schema$SeekSubscriptionRequest {
/**
* Seek to a named position with respect to the message backlog.
*/
namedTarget?: string | null;
/**
* Seek to the first message whose publish or event time is greater than or equal to the specified query time. If no such message can be located, will seek to the end of the message backlog.
*/
timeTarget?: Schema$TimeTarget;
}
/**
* Response for SeekSubscription long running operation.
*/
export interface Schema$SeekSubscriptionResponse {}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* Metadata about a subscription resource.
*/
export interface Schema$Subscription {
/**
* The settings for this subscription's message delivery.
*/
deliveryConfig?: Schema$DeliveryConfig;
/**
* The name of the subscription. Structured like: projects/{project_number\}/locations/{location\}/subscriptions/{subscription_id\}
*/
name?: string | null;
/**
* The name of the topic this subscription is attached to. Structured like: projects/{project_number\}/locations/{location\}/topics/{topic_id\}
*/
topic?: string | null;
}
/**
* A target publish or event time. Can be used for seeking to or retrieving the corresponding cursor.
*/
export interface Schema$TimeTarget {
/**
* Request the cursor of the first message with event time greater than or equal to `event_time`. If messages are missing an event time, the publish time is used as a fallback. As event times are user supplied, subsequent messages may have event times less than `event_time` and should be filtered by the client, if necessary.
*/
eventTime?: string | null;
/**
* Request the cursor of the first message with publish time greater than or equal to `publish_time`. All messages thereafter are guaranteed to have publish times \>= `publish_time`.
*/
publishTime?: string | null;
}
/**
* Metadata about a topic resource.
*/
export interface Schema$Topic {
/**
* The name of the topic. Structured like: projects/{project_number\}/locations/{location\}/topics/{topic_id\}
*/
name?: string | null;
/**
* The settings for this topic's partitions.
*/
partitionConfig?: Schema$PartitionConfig;
/**
* The settings for this topic's message retention.
*/
retentionConfig?: Schema$RetentionConfig;
}
/**
* Response for GetTopicPartitions.
*/
export interface Schema$TopicPartitions {
/**
* The number of partitions in the topic.
*/
partitionCount?: string | null;
}
export class Resource$Admin {
context: APIRequestContext;
projects: Resource$Admin$Projects;
constructor(context: APIRequestContext) {
this.context = context;
this.projects = new Resource$Admin$Projects(this.context);
}
}
export class Resource$Admin$Projects {
context: APIRequestContext;
locations: Resource$Admin$Projects$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Admin$Projects$Locations(this.context);
}
}
export class Resource$Admin$Projects$Locations {
context: APIRequestContext;
operations: Resource$Admin$Projects$Locations$Operations;
subscriptions: Resource$Admin$Projects$Locations$Subscriptions;
topics: Resource$Admin$Projects$Locations$Topics;
constructor(context: APIRequestContext) {
this.context = context;
this.operations = new Resource$Admin$Projects$Locations$Operations(
this.context
);
this.subscriptions = new Resource$Admin$Projects$Locations$Subscriptions(
this.context
);
this.topics = new Resource$Admin$Projects$Locations$Topics(this.context);
}
}
export class Resource$Admin$Projects$Locations$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.operations.cancel({
* // The name of the operation resource to be cancelled.
* name: 'projects/my-project/locations/my-location/operations/my-operation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(
params: Params$Resource$Admin$Projects$Locations$Operations$Cancel,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
cancel(
params?: Params$Resource$Admin$Projects$Locations$Operations$Cancel,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
cancel(
params: Params$Resource$Admin$Projects$Locations$Operations$Cancel,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
cancel(
params: Params$Resource$Admin$Projects$Locations$Operations$Cancel,
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
cancel(
params: Params$Resource$Admin$Projects$Locations$Operations$Cancel,
callback: BodyResponseCallback<Schema$Empty>
): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
cancel(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Operations$Cancel
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Operations$Cancel;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Operations$Cancel;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}:cancel').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.operations.delete({
* // The name of the operation resource to be deleted.
* name: 'projects/my-project/locations/my-location/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Admin$Projects$Locations$Operations$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Admin$Projects$Locations$Operations$Delete,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
delete(
params: Params$Resource$Admin$Projects$Locations$Operations$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Admin$Projects$Locations$Operations$Delete,
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(
params: Params$Resource$Admin$Projects$Locations$Operations$Delete,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
delete(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Operations$Delete
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Operations$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Operations$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.operations.get({
* // The name of the operation resource.
* name: 'projects/my-project/locations/my-location/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Admin$Projects$Locations$Operations$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Admin$Projects$Locations$Operations$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Operation>;
get(
params: Params$Resource$Admin$Projects$Locations$Operations$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Admin$Projects$Locations$Operations$Get,
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
callback: BodyResponseCallback<Schema$Operation>
): void;
get(
params: Params$Resource$Admin$Projects$Locations$Operations$Get,
callback: BodyResponseCallback<Schema$Operation>
): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
get(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Operations$Get
| BodyResponseCallback<Schema$Operation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Operation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Operation>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Operations$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Admin$Projects$Locations$Operations$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Operation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Operation>(parameters);
}
}
/**
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x\}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.operations.list({
* // The standard list filter.
* filter: 'placeholder-value',
* // The name of the operation's parent resource.
* name: 'projects/my-project/locations/my-location',
* // The standard list page size.
* pageSize: 'placeholder-value',
* // The standard list page token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "operations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Admin$Projects$Locations$Operations$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Admin$Projects$Locations$Operations$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListOperationsResponse>;
list(
params: Params$Resource$Admin$Projects$Locations$Operations$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Operations$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$ListOperationsResponse>,
callback: BodyResponseCallback<Schema$ListOperationsResponse>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Operations$List,
callback: BodyResponseCallback<Schema$ListOperationsResponse>
): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Operations$List
| BodyResponseCallback<Schema$ListOperationsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListOperationsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListOperationsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListOperationsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Operations$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Admin$Projects$Locations$Operations$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}/operations').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListOperationsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListOperationsResponse>(parameters);
}
}
}
export interface Params$Resource$Admin$Projects$Locations$Operations$Cancel
extends StandardParameters {
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelOperationRequest;
}
export interface Params$Resource$Admin$Projects$Locations$Operations$Delete
extends StandardParameters {
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Operations$Get
extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Operations$List
extends StandardParameters {
/**
* The standard list filter.
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
export class Resource$Admin$Projects$Locations$Subscriptions {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Creates a new subscription.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.subscriptions.create({
* // Required. The parent location in which to create the subscription. Structured like `projects/{project_number\}/locations/{location\}`.
* parent: 'projects/my-project/locations/my-location',
* // If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.
* skipBacklog: 'placeholder-value',
* // Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`.
* subscriptionId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "deliveryConfig": {},
* // "name": "my_name",
* // "topic": "my_topic"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deliveryConfig": {},
* // "name": "my_name",
* // "topic": "my_topic"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Create,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
create(
params?: Params$Resource$Admin$Projects$Locations$Subscriptions$Create,
options?: MethodOptions
): GaxiosPromise<Schema$Subscription>;
create(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Create,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
create(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Create,
options: MethodOptions | BodyResponseCallback<Schema$Subscription>,
callback: BodyResponseCallback<Schema$Subscription>
): void;
create(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Create,
callback: BodyResponseCallback<Schema$Subscription>
): void;
create(callback: BodyResponseCallback<Schema$Subscription>): void;
create(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Subscriptions$Create
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Subscription> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Subscriptions$Create;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Subscriptions$Create;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+parent}/subscriptions').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Subscription>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Subscription>(parameters);
}
}
/**
* Deletes the specified subscription.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.subscriptions.delete({
* // Required. The name of the subscription to delete.
* name: 'projects/my-project/locations/my-location/subscriptions/my-subscription',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Admin$Projects$Locations$Subscriptions$Delete,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
delete(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Delete,
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Delete,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
delete(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Subscriptions$Delete
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Subscriptions$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Subscriptions$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Returns the subscription configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.subscriptions.get({
* // Required. The name of the subscription whose configuration to return.
* name: 'projects/my-project/locations/my-location/subscriptions/my-subscription',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deliveryConfig": {},
* // "name": "my_name",
* // "topic": "my_topic"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Admin$Projects$Locations$Subscriptions$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Subscription>;
get(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Get,
options: MethodOptions | BodyResponseCallback<Schema$Subscription>,
callback: BodyResponseCallback<Schema$Subscription>
): void;
get(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Get,
callback: BodyResponseCallback<Schema$Subscription>
): void;
get(callback: BodyResponseCallback<Schema$Subscription>): void;
get(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Subscriptions$Get
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Subscription> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Subscriptions$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Subscriptions$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Subscription>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Subscription>(parameters);
}
}
/**
* Returns the list of subscriptions for the given project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.subscriptions.list({
* // The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number\}/locations/{location\}`.
* parent: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "subscriptions": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Admin$Projects$Locations$Subscriptions$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListSubscriptionsResponse>;
list(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$ListSubscriptionsResponse>,
callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$List,
callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Subscriptions$List
| BodyResponseCallback<Schema$ListSubscriptionsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListSubscriptionsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListSubscriptionsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListSubscriptionsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Subscriptions$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Subscriptions$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+parent}/subscriptions').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListSubscriptionsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListSubscriptionsResponse>(parameters);
}
}
/**
* Updates properties of the specified subscription.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.subscriptions.patch({
* // The name of the subscription. Structured like: projects/{project_number\}/locations/{location\}/subscriptions/{subscription_id\}
* name: 'projects/my-project/locations/my-location/subscriptions/my-subscription',
* // Required. A mask specifying the subscription fields to change.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "deliveryConfig": {},
* // "name": "my_name",
* // "topic": "my_topic"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deliveryConfig": {},
* // "name": "my_name",
* // "topic": "my_topic"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Patch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
patch(
params?: Params$Resource$Admin$Projects$Locations$Subscriptions$Patch,
options?: MethodOptions
): GaxiosPromise<Schema$Subscription>;
patch(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Patch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
patch(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Patch,
options: MethodOptions | BodyResponseCallback<Schema$Subscription>,
callback: BodyResponseCallback<Schema$Subscription>
): void;
patch(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Patch,
callback: BodyResponseCallback<Schema$Subscription>
): void;
patch(callback: BodyResponseCallback<Schema$Subscription>): void;
patch(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Subscriptions$Patch
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Subscription>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Subscription> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Subscriptions$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Subscriptions$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Subscription>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Subscription>(parameters);
}
}
/**
* Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.subscriptions.seek({
* // Required. The name of the subscription to seek.
* name: 'projects/my-project/locations/my-location/subscriptions/my-subscription',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "namedTarget": "my_namedTarget",
* // "timeTarget": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
seek(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Seek,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
seek(
params?: Params$Resource$Admin$Projects$Locations$Subscriptions$Seek,
options?: MethodOptions
): GaxiosPromise<Schema$Operation>;
seek(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Seek,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
seek(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Seek,
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
callback: BodyResponseCallback<Schema$Operation>
): void;
seek(
params: Params$Resource$Admin$Projects$Locations$Subscriptions$Seek,
callback: BodyResponseCallback<Schema$Operation>
): void;
seek(callback: BodyResponseCallback<Schema$Operation>): void;
seek(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Subscriptions$Seek
| BodyResponseCallback<Schema$Operation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Operation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Operation>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Subscriptions$Seek;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Subscriptions$Seek;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}:seek').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Operation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Operation>(parameters);
}
}
}
export interface Params$Resource$Admin$Projects$Locations$Subscriptions$Create
extends StandardParameters {
/**
* Required. The parent location in which to create the subscription. Structured like `projects/{project_number\}/locations/{location\}`.
*/
parent?: string;
/**
* If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.
*/
skipBacklog?: boolean;
/**
* Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`.
*/
subscriptionId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Subscription;
}
export interface Params$Resource$Admin$Projects$Locations$Subscriptions$Delete
extends StandardParameters {
/**
* Required. The name of the subscription to delete.
*/
name?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Subscriptions$Get
extends StandardParameters {
/**
* Required. The name of the subscription whose configuration to return.
*/
name?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Subscriptions$List
extends StandardParameters {
/**
* The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number\}/locations/{location\}`.
*/
parent?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Subscriptions$Patch
extends StandardParameters {
/**
* The name of the subscription. Structured like: projects/{project_number\}/locations/{location\}/subscriptions/{subscription_id\}
*/
name?: string;
/**
* Required. A mask specifying the subscription fields to change.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Subscription;
}
export interface Params$Resource$Admin$Projects$Locations$Subscriptions$Seek
extends StandardParameters {
/**
* Required. The name of the subscription to seek.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SeekSubscriptionRequest;
}
export class Resource$Admin$Projects$Locations$Topics {
context: APIRequestContext;
subscriptions: Resource$Admin$Projects$Locations$Topics$Subscriptions;
constructor(context: APIRequestContext) {
this.context = context;
this.subscriptions =
new Resource$Admin$Projects$Locations$Topics$Subscriptions(
this.context
);
}
/**
* Creates a new topic.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.topics.create({
* // Required. The parent location in which to create the topic. Structured like `projects/{project_number\}/locations/{location\}`.
* parent: 'projects/my-project/locations/my-location',
* // Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
* topicId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "name": "my_name",
* // "partitionConfig": {},
* // "retentionConfig": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "partitionConfig": {},
* // "retentionConfig": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(
params: Params$Resource$Admin$Projects$Locations$Topics$Create,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
create(
params?: Params$Resource$Admin$Projects$Locations$Topics$Create,
options?: MethodOptions
): GaxiosPromise<Schema$Topic>;
create(
params: Params$Resource$Admin$Projects$Locations$Topics$Create,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
create(
params: Params$Resource$Admin$Projects$Locations$Topics$Create,
options: MethodOptions | BodyResponseCallback<Schema$Topic>,
callback: BodyResponseCallback<Schema$Topic>
): void;
create(
params: Params$Resource$Admin$Projects$Locations$Topics$Create,
callback: BodyResponseCallback<Schema$Topic>
): void;
create(callback: BodyResponseCallback<Schema$Topic>): void;
create(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Topics$Create
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Topic> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Topics$Create;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Admin$Projects$Locations$Topics$Create;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+parent}/topics').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Topic>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Topic>(parameters);
}
}
/**
* Deletes the specified topic.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.topics.delete({
* // Required. The name of the topic to delete.
* name: 'projects/my-project/locations/my-location/topics/my-topic',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Admin$Projects$Locations$Topics$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Admin$Projects$Locations$Topics$Delete,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
delete(
params: Params$Resource$Admin$Projects$Locations$Topics$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Admin$Projects$Locations$Topics$Delete,
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(
params: Params$Resource$Admin$Projects$Locations$Topics$Delete,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
delete(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Topics$Delete
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Topics$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Admin$Projects$Locations$Topics$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Returns the topic configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.topics.get({
* // Required. The name of the topic whose configuration to return.
* name: 'projects/my-project/locations/my-location/topics/my-topic',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "partitionConfig": {},
* // "retentionConfig": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Admin$Projects$Locations$Topics$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Admin$Projects$Locations$Topics$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Topic>;
get(
params: Params$Resource$Admin$Projects$Locations$Topics$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Admin$Projects$Locations$Topics$Get,
options: MethodOptions | BodyResponseCallback<Schema$Topic>,
callback: BodyResponseCallback<Schema$Topic>
): void;
get(
params: Params$Resource$Admin$Projects$Locations$Topics$Get,
callback: BodyResponseCallback<Schema$Topic>
): void;
get(callback: BodyResponseCallback<Schema$Topic>): void;
get(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Topics$Get
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Topic> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Topics$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Admin$Projects$Locations$Topics$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Topic>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Topic>(parameters);
}
}
/**
* Returns the partition information for the requested topic.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.topics.getPartitions({
* // Required. The topic whose partition information to return.
* name: 'projects/my-project/locations/my-location/topics/my-topic',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "partitionCount": "my_partitionCount"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getPartitions(
params: Params$Resource$Admin$Projects$Locations$Topics$Getpartitions,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
getPartitions(
params?: Params$Resource$Admin$Projects$Locations$Topics$Getpartitions,
options?: MethodOptions
): GaxiosPromise<Schema$TopicPartitions>;
getPartitions(
params: Params$Resource$Admin$Projects$Locations$Topics$Getpartitions,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
getPartitions(
params: Params$Resource$Admin$Projects$Locations$Topics$Getpartitions,
options: MethodOptions | BodyResponseCallback<Schema$TopicPartitions>,
callback: BodyResponseCallback<Schema$TopicPartitions>
): void;
getPartitions(
params: Params$Resource$Admin$Projects$Locations$Topics$Getpartitions,
callback: BodyResponseCallback<Schema$TopicPartitions>
): void;
getPartitions(callback: BodyResponseCallback<Schema$TopicPartitions>): void;
getPartitions(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Topics$Getpartitions
| BodyResponseCallback<Schema$TopicPartitions>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$TopicPartitions>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$TopicPartitions>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$TopicPartitions> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Topics$Getpartitions;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Topics$Getpartitions;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}/partitions').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$TopicPartitions>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$TopicPartitions>(parameters);
}
}
/**
* Returns the list of topics for the given project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.topics.list({
* // The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The parent whose topics are to be listed. Structured like `projects/{project_number\}/locations/{location\}`.
* parent: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "topics": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Admin$Projects$Locations$Topics$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Admin$Projects$Locations$Topics$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListTopicsResponse>;
list(
params: Params$Resource$Admin$Projects$Locations$Topics$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Topics$List,
options: MethodOptions | BodyResponseCallback<Schema$ListTopicsResponse>,
callback: BodyResponseCallback<Schema$ListTopicsResponse>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Topics$List,
callback: BodyResponseCallback<Schema$ListTopicsResponse>
): void;
list(callback: BodyResponseCallback<Schema$ListTopicsResponse>): void;
list(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Topics$List
| BodyResponseCallback<Schema$ListTopicsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListTopicsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListTopicsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListTopicsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Topics$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Admin$Projects$Locations$Topics$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+parent}/topics').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListTopicsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListTopicsResponse>(parameters);
}
}
/**
* Updates properties of the specified topic.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await pubsublite.admin.projects.locations.topics.patch({
* // The name of the topic. Structured like: projects/{project_number\}/locations/{location\}/topics/{topic_id\}
* name: 'projects/my-project/locations/my-location/topics/my-topic',
* // Required. A mask specifying the topic fields to change.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "name": "my_name",
* // "partitionConfig": {},
* // "retentionConfig": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "partitionConfig": {},
* // "retentionConfig": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(
params: Params$Resource$Admin$Projects$Locations$Topics$Patch,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
patch(
params?: Params$Resource$Admin$Projects$Locations$Topics$Patch,
options?: MethodOptions
): GaxiosPromise<Schema$Topic>;
patch(
params: Params$Resource$Admin$Projects$Locations$Topics$Patch,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
patch(
params: Params$Resource$Admin$Projects$Locations$Topics$Patch,
options: MethodOptions | BodyResponseCallback<Schema$Topic>,
callback: BodyResponseCallback<Schema$Topic>
): void;
patch(
params: Params$Resource$Admin$Projects$Locations$Topics$Patch,
callback: BodyResponseCallback<Schema$Topic>
): void;
patch(callback: BodyResponseCallback<Schema$Topic>): void;
patch(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Topics$Patch
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Topic>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Topic> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Topics$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Admin$Projects$Locations$Topics$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Topic>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Topic>(parameters);
}
}
}
export interface Params$Resource$Admin$Projects$Locations$Topics$Create
extends StandardParameters {
/**
* Required. The parent location in which to create the topic. Structured like `projects/{project_number\}/locations/{location\}`.
*/
parent?: string;
/**
* Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
*/
topicId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Topic;
}
export interface Params$Resource$Admin$Projects$Locations$Topics$Delete
extends StandardParameters {
/**
* Required. The name of the topic to delete.
*/
name?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Topics$Get
extends StandardParameters {
/**
* Required. The name of the topic whose configuration to return.
*/
name?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Topics$Getpartitions
extends StandardParameters {
/**
* Required. The topic whose partition information to return.
*/
name?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Topics$List
extends StandardParameters {
/**
* The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The parent whose topics are to be listed. Structured like `projects/{project_number\}/locations/{location\}`.
*/
parent?: string;
}
export interface Params$Resource$Admin$Projects$Locations$Topics$Patch
extends StandardParameters {
/**
* The name of the topic. Structured like: projects/{project_number\}/locations/{location\}/topics/{topic_id\}
*/
name?: string;
/**
* Required. A mask specifying the topic fields to change.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Topic;
}
export class Resource$Admin$Projects$Locations$Topics$Subscriptions {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Lists the subscriptions attached to the specified topic.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await pubsublite.admin.projects.locations.topics.subscriptions.list({
* // Required. The name of the topic whose subscriptions to list.
* name: 'projects/my-project/locations/my-location/topics/my-topic',
* // The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopicSubscriptions` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "subscriptions": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListTopicSubscriptionsResponse>;
list(
params: Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>,
callback: BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>
): void;
list(
params: Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List,
callback: BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List
| BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListTopicSubscriptionsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/admin/{+name}/subscriptions').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListTopicSubscriptionsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListTopicSubscriptionsResponse>(
parameters
);
}
}
}
export interface Params$Resource$Admin$Projects$Locations$Topics$Subscriptions$List
extends StandardParameters {
/**
* Required. The name of the topic whose subscriptions to list.
*/
name?: string;
/**
* The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopicSubscriptions` must match the call that provided the page token.
*/
pageToken?: string;
}
export class Resource$Cursor {
context: APIRequestContext;
projects: Resource$Cursor$Projects;
constructor(context: APIRequestContext) {
this.context = context;
this.projects = new Resource$Cursor$Projects(this.context);
}
}
export class Resource$Cursor$Projects {
context: APIRequestContext;
locations: Resource$Cursor$Projects$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Cursor$Projects$Locations(this.context);
}
}
export class Resource$Cursor$Projects$Locations {
context: APIRequestContext;
subscriptions: Resource$Cursor$Projects$Locations$Subscriptions;
constructor(context: APIRequestContext) {
this.context = context;
this.subscriptions = new Resource$Cursor$Projects$Locations$Subscriptions(
this.context
);
}
}
export class Resource$Cursor$Projects$Locations$Subscriptions {
context: APIRequestContext;
cursors: Resource$Cursor$Projects$Locations$Subscriptions$Cursors;
constructor(context: APIRequestContext) {
this.context = context;
this.cursors =
new Resource$Cursor$Projects$Locations$Subscriptions$Cursors(
this.context
);
}
/**
* Updates the committed cursor.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await pubsublite.cursor.projects.locations.subscriptions.commitCursor({
* // The subscription for which to update the cursor.
* subscription:
* 'projects/my-project/locations/my-location/subscriptions/my-subscription',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "cursor": {},
* // "partition": "my_partition"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
commitCursor(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
commitCursor(
params?: Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor,
options?: MethodOptions
): GaxiosPromise<Schema$CommitCursorResponse>;
commitCursor(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
commitCursor(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor,
options:
| MethodOptions
| BodyResponseCallback<Schema$CommitCursorResponse>,
callback: BodyResponseCallback<Schema$CommitCursorResponse>
): void;
commitCursor(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor,
callback: BodyResponseCallback<Schema$CommitCursorResponse>
): void;
commitCursor(
callback: BodyResponseCallback<Schema$CommitCursorResponse>
): void;
commitCursor(
paramsOrCallback?:
| Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor
| BodyResponseCallback<Schema$CommitCursorResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$CommitCursorResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$CommitCursorResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$CommitCursorResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/cursor/{+subscription}:commitCursor').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['subscription'],
pathParams: ['subscription'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$CommitCursorResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$CommitCursorResponse>(parameters);
}
}
}
export interface Params$Resource$Cursor$Projects$Locations$Subscriptions$Commitcursor
extends StandardParameters {
/**
* The subscription for which to update the cursor.
*/
subscription?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CommitCursorRequest;
}
export class Resource$Cursor$Projects$Locations$Subscriptions$Cursors {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Returns all committed cursor information for a subscription.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await pubsublite.cursor.projects.locations.subscriptions.cursors.list({
* // The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListPartitionCursors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitionCursors` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number\}/locations/{location\}/subscriptions/{subscription_id\}`.
* parent:
* 'projects/my-project/locations/my-location/subscriptions/my-subscription',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "partitionCursors": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListPartitionCursorsResponse>;
list(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$ListPartitionCursorsResponse>,
callback: BodyResponseCallback<Schema$ListPartitionCursorsResponse>
): void;
list(
params: Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List,
callback: BodyResponseCallback<Schema$ListPartitionCursorsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$ListPartitionCursorsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List
| BodyResponseCallback<Schema$ListPartitionCursorsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListPartitionCursorsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListPartitionCursorsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListPartitionCursorsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/cursor/{+parent}/cursors').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListPartitionCursorsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListPartitionCursorsResponse>(
parameters
);
}
}
}
export interface Params$Resource$Cursor$Projects$Locations$Subscriptions$Cursors$List
extends StandardParameters {
/**
* The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListPartitionCursors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitionCursors` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number\}/locations/{location\}/subscriptions/{subscription_id\}`.
*/
parent?: string;
}
export class Resource$Topicstats {
context: APIRequestContext;
projects: Resource$Topicstats$Projects;
constructor(context: APIRequestContext) {
this.context = context;
this.projects = new Resource$Topicstats$Projects(this.context);
}
}
export class Resource$Topicstats$Projects {
context: APIRequestContext;
locations: Resource$Topicstats$Projects$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Topicstats$Projects$Locations(this.context);
}
}
export class Resource$Topicstats$Projects$Locations {
context: APIRequestContext;
topics: Resource$Topicstats$Projects$Locations$Topics;
constructor(context: APIRequestContext) {
this.context = context;
this.topics = new Resource$Topicstats$Projects$Locations$Topics(
this.context
);
}
}
export class Resource$Topicstats$Projects$Locations$Topics {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await pubsublite.topicStats.projects.locations.topics.computeHeadCursor({
* // Required. The topic for which we should compute the head cursor.
* topic: 'projects/my-project/locations/my-location/topics/my-topic',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "partition": "my_partition"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "headCursor": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
computeHeadCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
computeHeadCursor(
params?: Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor,
options?: MethodOptions
): GaxiosPromise<Schema$ComputeHeadCursorResponse>;
computeHeadCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
computeHeadCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor,
options:
| MethodOptions
| BodyResponseCallback<Schema$ComputeHeadCursorResponse>,
callback: BodyResponseCallback<Schema$ComputeHeadCursorResponse>
): void;
computeHeadCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor,
callback: BodyResponseCallback<Schema$ComputeHeadCursorResponse>
): void;
computeHeadCursor(
callback: BodyResponseCallback<Schema$ComputeHeadCursorResponse>
): void;
computeHeadCursor(
paramsOrCallback?:
| Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor
| BodyResponseCallback<Schema$ComputeHeadCursorResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ComputeHeadCursorResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ComputeHeadCursorResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ComputeHeadCursorResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/v1/topicStats/{+topic}:computeHeadCursor'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['topic'],
pathParams: ['topic'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ComputeHeadCursorResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ComputeHeadCursorResponse>(parameters);
}
}
/**
* Compute statistics about a range of messages in a given topic and partition.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await pubsublite.topicStats.projects.locations.topics.computeMessageStats({
* // Required. The topic for which we should compute message stats.
* topic: 'projects/my-project/locations/my-location/topics/my-topic',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "endCursor": {},
* // "partition": "my_partition",
* // "startCursor": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "messageBytes": "my_messageBytes",
* // "messageCount": "my_messageCount",
* // "minimumEventTime": "my_minimumEventTime",
* // "minimumPublishTime": "my_minimumPublishTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
computeMessageStats(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
computeMessageStats(
params?: Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats,
options?: MethodOptions
): GaxiosPromise<Schema$ComputeMessageStatsResponse>;
computeMessageStats(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
computeMessageStats(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats,
options:
| MethodOptions
| BodyResponseCallback<Schema$ComputeMessageStatsResponse>,
callback: BodyResponseCallback<Schema$ComputeMessageStatsResponse>
): void;
computeMessageStats(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats,
callback: BodyResponseCallback<Schema$ComputeMessageStatsResponse>
): void;
computeMessageStats(
callback: BodyResponseCallback<Schema$ComputeMessageStatsResponse>
): void;
computeMessageStats(
paramsOrCallback?:
| Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats
| BodyResponseCallback<Schema$ComputeMessageStatsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ComputeMessageStatsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ComputeMessageStatsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ComputeMessageStatsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/v1/topicStats/{+topic}:computeMessageStats'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['topic'],
pathParams: ['topic'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ComputeMessageStatsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ComputeMessageStatsResponse>(parameters);
}
}
/**
* Compute the corresponding cursor for a publish or event time in a topic partition.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/pubsublite.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const pubsublite = google.pubsublite('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await pubsublite.topicStats.projects.locations.topics.computeTimeCursor({
* // Required. The topic for which we should compute the cursor.
* topic: 'projects/my-project/locations/my-location/topics/my-topic',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "partition": "my_partition",
* // "target": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "cursor": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
computeTimeCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
computeTimeCursor(
params?: Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor,
options?: MethodOptions
): GaxiosPromise<Schema$ComputeTimeCursorResponse>;
computeTimeCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
computeTimeCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor,
options:
| MethodOptions
| BodyResponseCallback<Schema$ComputeTimeCursorResponse>,
callback: BodyResponseCallback<Schema$ComputeTimeCursorResponse>
): void;
computeTimeCursor(
params: Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor,
callback: BodyResponseCallback<Schema$ComputeTimeCursorResponse>
): void;
computeTimeCursor(
callback: BodyResponseCallback<Schema$ComputeTimeCursorResponse>
): void;
computeTimeCursor(
paramsOrCallback?:
| Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor
| BodyResponseCallback<Schema$ComputeTimeCursorResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ComputeTimeCursorResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ComputeTimeCursorResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ComputeTimeCursorResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://pubsublite.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/v1/topicStats/{+topic}:computeTimeCursor'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['topic'],
pathParams: ['topic'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ComputeTimeCursorResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ComputeTimeCursorResponse>(parameters);
}
}
}
export interface Params$Resource$Topicstats$Projects$Locations$Topics$Computeheadcursor
extends StandardParameters {
/**
* Required. The topic for which we should compute the head cursor.
*/
topic?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ComputeHeadCursorRequest;
}
export interface Params$Resource$Topicstats$Projects$Locations$Topics$Computemessagestats
extends StandardParameters {
/**
* Required. The topic for which we should compute message stats.
*/
topic?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ComputeMessageStatsRequest;
}
export interface Params$Resource$Topicstats$Projects$Locations$Topics$Computetimecursor
extends StandardParameters {
/**
* Required. The topic for which we should compute the cursor.
*/
topic?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ComputeTimeCursorRequest;
}
}